home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / printer / jcosub26.zip / OVERVIEW.DOC < prev    next >
Text File  |  1997-05-03  |  35KB  |  746 lines

  1.           JACOsub: video titling software for professionals
  2.                             version 2.6b
  3.                Timed Script Editor, Timer, and Player
  4.              A Product from Unicorn Research Corporation
  5.  
  6.  
  7. This document provides an overview of the JACOsub software package
  8. (features, installation, compatibility, script conversion, and product
  9. support).  Be sure to read the product support section concerning bug
  10. reports, if you don't read anything else.  Other documentation files in
  11. this package are:
  12.  
  13.    JACOsub.doc  - Information on operating the program.
  14.    JScripts.doc - Detailed information on the JACOsub script format
  15.                   specification.
  16.    ARexx.doc    - Covers ARexx communications with JACOsub (Amiga only).
  17.    QuickRef.doc - Quick reference for script commands and directives.
  18.    FAQ          - Some Frequently Asked Questions, with answers.
  19.    Register.doc - Information about registering the software.
  20.  
  21. CONTENTS OF THIS DOCUMENT
  22. =========================
  23.  
  24.  1.  What is JACOsub?
  25.  2.  Special features of JACOsub
  26.  3.  System requirements
  27.  4.  Installation
  28.      a.  General information
  29.      b.  Installation on SINGLE-DRIVE systems
  30.  5.  Interactions with other software and hardware
  31.  6.  Genlock support
  32.  7.  ARexx support (see ARexx.doc)
  33.  8.  JConvert script conversion utility
  34.  9.  JACOsub script file format specification (see JScripts.doc)
  35. 10.  Shareware registration / commercial licensing (see register.doc)
  36. 11.  Legal disclaimer
  37. 12.  Support, technical questions, suggestions, bug reports
  38. 13.  KNOWN BUGS -- PLEASE HELP
  39.  
  40.  
  41. 1.  WHAT IS JACOsub?
  42. ====================
  43.  
  44. JACOsub is a program designed for displaying timed sequences of titles and
  45. graphics over a video.  Professional-quality output and flexibility have
  46. been the primary goals since the program's inception.  It was originally
  47. written for the Japanese Animation Club of Orlando (JACO) to lay English
  48. subtitles over Japanese-language films and television shows.  The program
  49. has spread and grown in popularity due to its extremely flexible script
  50. format, clean multi-buffered title transitions, and other features
  51. described in the next section.
  52.  
  53. The development of JACOsub has been primarily user-driven.  Most of the
  54. program's more interesting features exist because users suggested them.
  55. Because of the valuable input given by so many people, JACOsub has become
  56. an exceptionally powerful program while retaining its initial simplicity
  57. at the same time.
  58.  
  59.  
  60. 2.  SPECIAL FEATURES OF JACOsub
  61. ===============================
  62.  
  63.  *  Non-sequential events.  Title time ranges may overlap.  Unlimited
  64.     indepenedent title sequences may be displayed simultaneously.
  65.  
  66.  *  Fully integrated text-based script editor with optional user interface
  67.     for title appearance attributes.  If needed, video titles may be
  68.     positioned graphically with the mouse.
  69.  
  70.  *  Handles all kinds of time units: SMPTE, PAL, 1/100 second units, etc.
  71.  
  72.  *  Extremely flexible timing script file format, allowing comments, blank
  73.     lines, text directives, and global configuration commands.  Scripts can
  74.     be as simple or as complex as you want.  Scripts may even include other
  75.     scripts, so you don't have to re-time parts that you use over and over
  76.     again.
  77.  
  78.  *  Complete script-based control over text position, margins, font, style,
  79.     colors, palettes, backshadow, word-wrapping, and justification.  You
  80.     can even generate anti-aliased outlines and shadows on mono-color text.
  81.     Text appearance can be controlled through line directives or with
  82.     C-style escape code inside the subtitle text.
  83.  
  84.  *  Real-time script timing procedure allows you to time your script in
  85.     small sections, and in independent tracks.  The program offers
  86.     intelligent calculation of title end times and forced gaps, leaving you
  87.     free to concentrate only on title start times during timing.  End times
  88.     may be also timed separately from start times.
  89.  
  90.  *  Display graphic images with the text.  Time ranges for graphic images
  91.     may overlap also.  Graphics (IFF pictures or brushes) may be positioned
  92.     anywhere on the screen.  If you do not need to generate text over
  93.     graphics, you can load IFF pictures independently of JACOsub's display.
  94.     JACOsub supports AGA graphics.  PCX files supported under MSDOS for
  95.     stand-alone display without overlaying text.
  96.  
  97.  *  Support for transition effects (for example, wipe, iris, blinds, roll),
  98.     and smooth scrolling titles.
  99.  
  100.  *  Multi video buffering and page switching.  Many titling programs create
  101.     a display in a hidden buffer, then blit it to the visible foreground at
  102.     the proper time.  But the duration of a multi-bitplane blit can be up
  103.     to 3 video frames.  This can cause disconcerting "flashing" or tearing
  104.     effects.  Many PD/shareware titling programs have this problem.
  105.     JACOsub has a better way:  It uses video-page switching rather than
  106.     blitting, to move displays to the foreground.  Images appear
  107.     instantaneously during the vertical CRT blank interval.  Blitting is
  108.     only used to copy data between up to 7 hidden video buffers, never on
  109.     the visible display.
  110.  
  111.  *  You can make time shift and drift adjustments "on the fly" while your
  112.     script is playing.
  113.  
  114.  *  ARexx support (Amiga only) -- other programs can issue commands to
  115.     JACOsub, and your JACOsub scripts can execute ARexx scripts while
  116.     playing.  You can even control JACOsub's editor through ARexx.
  117.  
  118.  *  Genlock dissolves (Amiga only): You can control the Digital Creations
  119.     SuperGen genlock faders directly from your script!  GVP and Video
  120.     Toaster genlock fades may be controlled indirectly through ARexx.
  121.  
  122.  *  Robust compiler diagnostics for tracking down problems in your scripts.
  123.  
  124.  *  Support for 3rd-party script formats:  TurboTitle (.tts), Phoenix
  125.     Japanimation Society (.pjs), generic (.tim), Panimator (.pan), Subtitle
  126.     (.sub), ZeroG (.zeg), and MacSubtitler (.scr).  The Jconvert utility is
  127.     provided to convert all these formats to JACOsub (.js) format.  JACOsub
  128.     can read .tts, .pjs, and .tim scripts without prior conversion.
  129.  
  130.  
  131. Author:  Alex Matulich
  132.          1515 Jefferson Davis Hwy #820
  133.          Arlington, VA 22202-3311
  134.          (703) 413-0215
  135.          email: matulich_a@seaa.navsea.navy.mil
  136.  
  137. JACOsub WWW site: http://www.unicorn.us.com/jacosub
  138.  
  139. Original Beta Testers:
  140.          Fred A. Leggett III (JACO), Daric Kozlowski (JACO)
  141.          Tom Perry (Phoenix Japanimation Society)
  142.          Noel Gamboa (Operation X)
  143.          Robert Lowrey (Central Anime)
  144.          Roger Ang, Jacob Ellis, Dave Fleming,
  145.          Mike Harlock, Tommy Hwang, Ed Sum
  146.  
  147. Compilers:  SAS C/C++ 6.51 (Amiga), Zortech C++ (MSDOS).
  148. Computers:  Amiga 1000 (never say die!) with WorkBench 2.1,
  149.             AmigaDOS 2.04 ROM hacked in, 2M FAST, 512K CHIP, 30MB C-Ltd HD.
  150.             Zenith Z-NoteFlex 486/50, MSDOS 6.2, 12 MB RAM (1 MB SVGA).
  151.  
  152.  
  153. 3.  SYSTEM REQUIREMENTS
  154. =======================
  155.  
  156. JACOsub will run on:
  157. * Any model Amiga computer, either PAL or NTSC.
  158. * Any MSDOS 80386+ PC with a 1 megabyte SVGA card.
  159.  
  160. Recommended hardware requirements:
  161. * (Amiga) At least 1 megabyte RAM, _preferably_ more than 1.5 megabytes.
  162.   (MSDOS) 1 megabyte conventional memory, 1 megabyte display memory,
  163.           and 1 megabyte extended memory with EMM386.EXE driver.
  164. * Two storage devices (2 floppy drives, hard disk and floppy, or single
  165.   drive plus RAM disk [requires extra memory]).
  166.  
  167. Amiga software requirements:
  168. * AmigaDOS 2.0 or greater (program WILL run under 1.3; see next section
  169.   for caveats concerning 1.3).
  170. * libs: directory should contain
  171.   + asl.library or req.library (for file requesters).
  172.   + iffparse.library (for IFF file support; 1.3-compatible version exists).
  173.   + supergen.library and copinint.library (if you have a SuperGen genlock).
  174.   The program will still run without any of these libraries.
  175.  
  176. MSDOS software requirements:
  177. * DOS version 5.0 or higher.
  178. * EMM386.EXE in CONFIG.SYS.
  179. * DOS, TSRs, and drivers loaded HIGH in CONFIG.SYS.
  180.  
  181. Additional hardware needed for video work:
  182. * Genlock for overlaying computer images onto video.
  183. * Source video device, preferably a laserdisc player.
  184. * Videocassete recorder for making master recordings.
  185. * If you are able, a second video monitor is useful but not required.
  186.  
  187.  
  188. 4.  INSTALLATION
  189. ================
  190.  
  191. a. General information
  192. ----------------------
  193.  
  194. After extracting the archive you should have the files in the list below.
  195. An "I" in the first column indicates that the file has an icon (.info file)
  196. associated with it (icons, ARexx files, and superhires fonts are not
  197. included in the MSDOS version).
  198.  
  199. I  README.1st                  Quick install and run instructions
  200. I  CHANGES.TXT                 List of improvements and bug fixes
  201. I  InstallFonts                Installs JACOsub's fonts into fonts:
  202. I  JACOsub                     The timing script compiler & player
  203.    JACOsub.cfg                 Empty config file to replace older ones
  204. I  jconvert                    Conversion utility for 3rd-party scripts
  205.    proglogo.bbm/pcx            Initial graphic that appears in the editor
  206.    tips.txt                    Tips to display when program starts up
  207. I  documentation (subdirectory)
  208. I     Overview.doc             You're reading it now
  209. I     JACOsub.doc              Documentation on operating the software
  210. I     JScripts.doc             JACOsub Script file format specification
  211. I     ARexx.doc                ARexx communications documentation
  212. I     Register.doc             Shareware registration instructions
  213. I     FAQ                      Frequently-Asked Questions, with answers
  214.    fonts (subdirectory)
  215.       JACOsub.font             A few high-quality video titling fonts
  216.       JACOsub (subdirectory)
  217.          18                    18-pixel height monochrome font for clock
  218.          29.4C                 29-pixel international color outline font
  219.          32.4C                 32-pixel international outline/shadow font
  220.          36.4C                 36-pixel international outline/shadow font
  221.       JACOsub_mono.font        Mono-color fonts (same char sizes as color)
  222.       JACOsub_mono (subdirectory)
  223.          25                    Mono-color version of 29-pixel color font
  224.          32                    Mono-color version of 36-pixel color font
  225.       JACOsub_superhires.font  Titling font for use in SUPERHIRES mode
  226.       JACOsub_superhires (subdirectory)
  227.          36.4C                 SUPERHIRES color outline font
  228.    rexx (subdirectory)
  229.       abortplay.jsrx           Demo of ABORTPLAY ARexx command
  230.       begintime.jsrx           Demo of BEGINTIME ARexx command
  231.       loadscript.jsrx          Demo of LOADSCRIPT ARexx command
  232.       playsetup.jsrx           Demo of PLAYSETUP ARexx command
  233.       playstart.jsrx           Demo of PLAYSTART ARexx command
  234.       quit.jsrx                Demo of QUIT ARexx command
  235.       savescript.jsrx          Demo of SAVESCRIPT Arexx command
  236.       screentoback.jsrx        Demo of SCREENTOBACK ARexx command
  237.       screentofront.jsrx       Demo of SCREENTOFRONT ARexx command
  238.       etc...                   ...and various others described in ARexx.doc
  239. I  scripts (subdirectory)
  240. I     demo.js                  Demonstration script for JACOsub
  241. I     idemo.js                 Secondary script included by demo.js
  242. I     JACO.bbm/pcx             Graphic logo; IFF brush used by demo.js
  243. I     cycldemo.js              Demo script for color cycling
  244. I     helium.lbm/pcx           Graphic file used with cyclscrl.js
  245. I     scrldemo.js              Demo script for smooth scrolling titles
  246.  
  247. IF YOU AREN'T AN AMIGA USER, SKIP TO SECTION 8 (JCONVERT SCRIPT CONVERSION
  248. UTILITY).  EVERYTHING UP UNTIL THAT POINT IS RELEVANT ONLY TO AMIGAS.
  249.  
  250. All you need to do to install the software after you extract the archive,
  251. is copy the supplied fonts to your fonts: directory.  To do this, simply
  252. double-click on the "InstallFonts" icon, or enter these commands from the
  253. JACOsub directory at a Shell prompt:
  254.  
  255.    copy fonts fonts: all       ;copy the supplied fonts
  256.    delete fonts all            ;delete the fonts directory created by the
  257.                                ;archive extraction.
  258.  
  259. THE JACOsub FONTS MUST BE IN YOUR FONTS: DIRECTORY PRIOR TO RUNNING THE
  260. PROGRAM FOR THE FIRST TIME.  The fonts get updated and improved
  261. periodically, so you should always re-install them if CHANGES.TXT indicates
  262. that it is necessary.  BE SURE YOUR SYSTEM CLOCK IS SET CORRECTLY BEFORE
  263. INSTALLING THE FONTS, because JACOsub checks the jacosub.font date to see
  264. if it's recent enough.
  265.  
  266. If you have a SuperGen genlock, you need to make sure that your LIBS:
  267. directory contains supergen.library and copinit.library.  If they are
  268. missing, you won't be able to control your SuperGen from JACOsub scripts.
  269.  
  270. Before you run the program, you should be aware of some issues concerning
  271. different versions of AmigaDOS:
  272.  
  273.    AmigaDOS 1.2:  You will not be able to run JACOsub with color fonts.
  274.    If you boot up with a 1.3 disk using 1.2 Kickstart, you may have better
  275.    luck.  In any case, upgrade to 1.3 or 2.0 as soon as you can.  Your
  276.    libs: directory should contain req.library.  JACOsub does not support
  277.    AmigaDOS 1.2; if it works at all, it is purely by accident.
  278.  
  279.    AmigaDOS 1.3:  You will need to load a Colortext driver prior to running
  280.    JACOsub.  A good Colortext driver by InterActive Softworks is supplied
  281.    with Deluxe Paint IV or Calligrapher.  If you don't load this driver,
  282.    you will see only single-colored characters while JACOsub runs.
  283. >> DO NOT USE ColorTextWedge 1.2 (supplied with TurboTitle) -- it forces
  284.    all text into JAM2 mode which chops up fonts having overlapping
  285.    dropshadows (such as the supplied JACOsub font).  Also, your libs:
  286.    directory should contain req.library, though it's not required.
  287. >> Under 1.3, JACOsub's IFF capabilities will be unavailable to you unless
  288.    you have a 1.3-compatible version of iffparse.library in your libs:
  289.    directory.  ARexx operations have a similar restriction under 1.3.
  290.  
  291.    AmigaDOS 2.x users do not need any special Colortext driver -- it's
  292.    built into the OS.  You don't need req.library, but your libs: directory
  293.    should contain the AmigaDOS asl.library.  It's a good idea to patch it
  294.    with the reqtools.library patch utility if you have it.  Under AmigaDOS
  295.    2.x, you will be unable to load files using AGA video modes.
  296.  
  297.    AmigaDOS 3.0 and above:  Should behave the same as AmigaDOS 2.x, except
  298.    that you can load IFF files in AGA graphic modes.
  299.  
  300. Now you're ready to begin.  Just click twice on JACOsub's program icon, or
  301. type "run jacosub" from a Shell prompt.  Refer to JACOsub.doc for more
  302. detailed information on operating the program.
  303.  
  304. b.  Installation on single-drive systems
  305. ----------------------------------------
  306.  
  307. This procedure requires some knowledge of the AmigaDOS Shell.
  308.  
  309. If your computer's only storage device is a single floppy disk drive, you
  310. will need to create a minimal Workbench disk that will allow you to boot up
  311. your machine and run JACOsub on the same disk.  The scripts directory
  312. contains a Shell script called MakeWB that will create a minimal Workbench
  313. disk for you.
  314.  
  315. To make a minimal Workbench disk, follow these steps:
  316.  
  317. 1.  Make a copy of your original Commodore-issue Workbench disk.
  318.  
  319. 2.  Boot up from it.
  320.  
  321. 3.  Copy MakeWB to this disk.
  322.  
  323. 4.  Execute MakeWB from a Shell prompt by typing this line:
  324.     makewb df0:
  325.     (assuming df0: is the name of your floppy drive; some Amigas use fd0:).
  326.  
  327. 5.  The script will copy the necessary files to RAM: and then ask you to
  328.     insert a formatted floppy disk in the drive.  After you do this, it
  329.     will copy the files needed for a minimal Workbench boot disk from RAM:
  330.     to the blank disk.  The new disk should be about 30% full.
  331.  
  332. After you have made your boot disk, you should have enough space on it to
  333. copy the files in JACOsub's main directory to the root of your new disk,
  334. and JACOsub's fonts to the new disk's fonts: directory.  You will probably
  335. not have enough room to copy the documentation.
  336.  
  337.  
  338. 5.  INTERACTIONS WITH OTHER SOFTWARE AND HARDWARE
  339. =================================================
  340.  
  341. Beta Versions of AmigaDOS:
  342.  
  343.    Avoid.  In particular, a beta version of AmigaDOS 2.1 has been known
  344.    to result in strange "snow," or random flecks of color, appearing on
  345.    the screen while JACOsub plays a script.
  346.  
  347. Directory Opus 4.0:
  348.  
  349.    DO NOT use JACOsub with Directory Opus 4.0!  This version of Directory
  350.    Opus has some known problems that will cause you much grief if you try
  351.    to run JACOsub with it.  You should probably avoid directory utilities
  352.    altogether when running JACOsub!
  353.  
  354. EPU, PowerPacker, and other filesystem compression utilities:
  355.  
  356.    File compressors used to give JACOsub problems before version 1.9 if
  357.    the compressor was set to report the compressed sizes of files, rather
  358.    than the original, uncompressed size.  This no longer matters; disk
  359.    compression should cause no trouble.
  360.  
  361. Text editors:
  362.  
  363.    Some users have reported that certain text editors, when run in the
  364.    background while JACOsub is running, will mess up time events.  TxEd
  365.    causes no problems at all.  Other users have reported no problems with
  366.    CED.  In any case, it is probably a good idea to shut down unnecessary
  367.    tasks before running ANY timing-critical application such as JACOsub.
  368.  
  369. req.library:
  370.  
  371.    Req.library seems to have a problem handling directory names that
  372.    contain spaces.  It's a good idea to avoid spaces in file names anyway.
  373.    You should have either asl.library or req.library in your libs:
  374.    directory.  The program should still work fine without these, however.
  375.    Warning:  There have been instances of req.library trashing memory
  376.    location $00000078 (in the zero-page memory area) which is dangerous for
  377.    AmigaDOS.  If your computer crashes right before a file requester should
  378.    appear, the fault is with req.library, not JACOsub.  JACOsub will use
  379.    asl.library if it can be found.
  380.  
  381. reqtools.library:
  382.  
  383.    Highly recommended!  The patch utility that comes with reqtools.library
  384.    patches req.library, asl.library, and arp.library to use features in
  385.    reqtools.library.  It fixes the problem with req.library described
  386.    above.  Reqtools.library makes your Amiga (and JACOsub) significantly
  387.    more pleasant to use.
  388.  
  389.    HOWEVER, you should NOT use rexxreqtools.library.  Rexxreqtools.library
  390.    has been observed to cause inexplicable crashes with JACOsub.
  391.  
  392. CPUBlit:
  393.  
  394.    Highly recommended for fast Amigas.  This speeds up basic blitter copy
  395.    operations.  ftp://ftp.wustl.edu/pub/aminet/util/boot/CpuBlit.lha
  396.  
  397. VideoTitler:
  398.  
  399.    Recommended.  VideoTitler can do some cool effects that JACOsub can't.
  400.    The authors of JACOsub and VideoTitler have cooperated to get the two
  401.    programs to communicate with each other through ARexx.  Check it out.
  402.    It should be available on any Aminet site.
  403.  
  404. Genlocks:
  405.  
  406.    In general, be sure all video sources are off, and your genlock is not
  407.    trying to gain a lock on anything, when you boot up your computer.
  408.    Genlocks affect the Amiga's internal clocking, and can cause timing
  409.    instabilities if you power everything up in the wrong order.  GVP
  410.    genlocks seem to be especially fussy about how they are brought online.
  411.  
  412.    GVP users: load IFF files with JACOsub at your own risk.  As of 1993,
  413.    there is an incompatibility between the GVP and the AmigaDOS IFF loader
  414.    routines.  Contact Great Valley Products for more information and
  415.    updated software.
  416.  
  417.    SuperGen users should have at least version 2.0 of the supergen.library
  418.    and copinit.library.  See the GENLOCK SUPPORT section below for details.
  419.  
  420.    The Rendale 8802 FMC NTSC genlock is known to slow down the internal
  421.    timer quite drastically on the Amiga 500, rendering it useless for
  422.    playing timed scripts.  This genlock works OK on the A1200, however.  At
  423.    this time (March 1996) the manufacturer is aware of the problem.
  424.  
  425. GVP 1230+ Turbo Series II accelerator:
  426.  
  427.    If you have problems with mysterious lockups, or random pixels appearing
  428.    on the screen, try re-seating the chips.  If that doesn't work, then
  429.    disable the data cache using the CPU NODATACACHE AmigaDOS command.
  430.  
  431.  
  432. 6.  GENLOCK SUPPORT
  433. ===================
  434.  
  435. SuperGen (Digital Creations)
  436. --------
  437.  
  438. JACOsub allows your scripts to control the faders on a SuperGen genlock.
  439. You need to have supergen.library and copinit.library in your libs:
  440. directory to take advantage of this feature.  These libraries are available
  441. from the libs directory of your Digital Creations SuperGen software disk.
  442. SUPERGEN.LIBRARY VERSIONS LESS THAN 2.0 WILL NOT WORK WITH JACOsub.
  443.  
  444. If your SuperGen library is too old, your fades will look jittery.  Update
  445. your SuperGen library as soon as possible.
  446.  
  447. JACOsub will not assume control over the SuperGen until it must execute a
  448. fader command.  From that point on, the genlock will be under software
  449. control until the script play terminates, and then control will be returned
  450. to manual mode.
  451.  
  452. Warning!  DO NOT BOOT UP YOUR AMIGA WITH A SIGNAL PRESENT ON THE SUPERGEN'S
  453. VIDEO INPUT!!  Doing so will adversly affect the Amiga's system clock,
  454. which will cause your scripts to run erratically or much too fast!
  455.  
  456. See the G directive in the Script Format Specification documentation
  457. JScripts.doc, for information on controlling the SuperGen.  Other genlocks
  458. will be supported as software and documentation becomes available to the
  459. author.
  460.  
  461. GVP Genlock (Great Valley Products)
  462. -----------
  463.  
  464. Dissolves with the GVP G-Lock must be controlled through ARexx.  JACOsub
  465. will look for the ARexx script "gvpfade.jsrx" in the current directory, a
  466. "rexx" subdirectory under the current directory, and in REXX:, and copy the
  467. script to ram:glfade.jsrx for faster execution.  This script is currently
  468. not provided.  See the file ARexx.doc for specifications of this script.
  469. If you create such a script, please send it to us!
  470.  
  471. If you have a GVP Genlock, PLAY SCRIPTS THAT LOAD IFF GRAPHICS AT YOUR OWN
  472. RISK!  Your Amiga WILL VERY LIKELY crash!  Great Valley Products says that
  473. the normal AmigaDOS IFF loading routines cause problems when the GVP is in
  474. operation.  Contact GVP for updated software.  Setting GENLOCK to GVP in
  475. your JACOsub.cfg file will cause a compile-time warning to be issued if a
  476. script attempts to load an IFF file.
  477.  
  478. Video Toaster (NewTek)
  479. -------------
  480.  
  481. The first paragraph under "GVP Genlock) above applies to the Video Toaster
  482. also, only the script should be named "toasterfade.jsrx."
  483.  
  484. General Information
  485. -------------------
  486.  
  487. Warning!  The genlock may sometimes show things that do not appear on the
  488. RGB display.  Some examples we discovered:
  489.  
  490.    A vertical line appears on the right edge of genlocked display, but not
  491.    on the RGB display.  The solution is to make sure the horizontal screen
  492.    size is a multiple of 32, such as 640, 672, or 704.  Digital Creations
  493.    tells us that this line won't appear on your videotape, but we suspect
  494.    they're talking about a different phenomenon.  JACOsub won't let you
  495.    specify screen widths that are not a multiple of 32.
  496.  
  497.    Little pieces of characters from the left side of the screen appear
  498.    on the right edge.  This happens when a character's kern setting causes
  499.    the left edge of the screen to clip off a pixel or two, as in the 'W'
  500.    and 't' of the 36-pixel JACOsub font.  You can see this when you run
  501.    the demo script after changing the left margin to 0% by inserting the
  502.    line #HL0 at the top of the script.  Solution:  Use the HL1 directive
  503.    instead of HL0, to provide a few pixels of margin space.  This will keep
  504.    kerned characters from going past the left edge of the display.
  505.  
  506.  
  507. 7.  AREXX SUPPORT
  508. =================
  509.  
  510. If you have ARexx, JACOsub will open an ARexx port called 'JACOsub'.  You
  511. can use a different program (such as SCALA for example) to issue a number
  512. of commands to JACOsub, and you can have JACOsub execute ARexx scripts
  513. while a JACOsub script is playing.  For more information, see the file
  514. ARexx.doc.
  515.  
  516.  
  517. 8.  JCONVERT SCRIPT CONVERSION UTILITY
  518. ======================================
  519.  
  520. Although JACOsub can read directly TurboTitle and Phoenix scripts, they
  521. won't be able to use many of JACOsub's advanced features.  If you need text
  522. with non-sequential, overlapping time ranges, or if you need to control the
  523. positioning or attributes of the text, or if you want to play a Panimator
  524. or MacSubtitler script with JACOsub, you must convert the script to the
  525. JACOsub script format.
  526.  
  527. Converting scripts to JACOsub format is simple.  It can be done through the
  528. Shell or through Workbench.  The Shell command is
  529.  
  530.    jconvert [-v[erbose]] scriptname1.ext [scriptname2.ext] ...
  531.  
  532. where .ext can be:
  533.    .tts (TurboTitle)
  534.    .pjs (Phoenix Japanimation Society)
  535.    .tim (Generic)
  536.    .pan (Panimator)
  537.    .sub (Subtitle)
  538.    .zeg (ZeroG)
  539.    .scr (MacSubtitler)
  540.  
  541. The optional -v or -verbose switch causes jconvert to echo its output to
  542. the screen as it writes the new file.
  543.  
  544. (To run jconvert from Workbench, you can click on its icon twice.  A file
  545. requester will appear, allowing you to select a file to convert.  If you
  546. have SCRIPTPATH specified in JACOsub.cfg, jconvert will use this as the
  547. starting directory for the file requester.  Or, if you need to convert
  548. multiple scripts, you may multiply select your script icons (clicking while
  549. holding down the SHIFT key) ending with a double-click on the jconvert
  550. icon.)
  551.  
  552. Jconvert will read in the script, and write out a new script file called
  553. scriptname.js which will be in JACOsub format.  Then you can modify
  554. scriptname.js to take advantage of JACOsub's advanced features.
  555.  
  556. Source code for jconvert is public domain, and available separately.  It
  557. should work for any computer or operating system.  If you need it, write to
  558. the author, check the FTP site, or call Anime Central BBS (see information
  559. at the end of this document for support resources).
  560.  
  561. NOTICE:  If you have a script that JACOsub can read directly without prior
  562. conversion (.tts, .pjs., .tim), then you should let JACOsub try to read and
  563. play your script once before converting it with jconvert, because JACOsub
  564. can inform you of potential problems, but jconvert cannot.  Jconvert does
  565. not analyze your scripts; it simply converts them blindly.  The only
  566. exception is when converting TurboTitle scripts, jconvert will correct
  567. overlapping time ranges by shortening the previous line's end time to be
  568. equal to the current line's start time.
  569.  
  570.  
  571. 9.  JACOsub SCRIPT FILE FORMAT SPECIFICATION
  572. ============================================
  573.  
  574. See the textfile JScripts.doc for a complete description of the JACOsub
  575. script file format.
  576.  
  577. About those 3rd-party file formats
  578. ----------------------------------
  579.  
  580. Robert Jenks, the author of TurboTitle, made an excellent suggestion in his
  581. documentation, that the TurboTitle format should be adopted as a standard
  582. for future software.  JACOsub is compatible with TurboTitle files, but the
  583. TurboTitle format was just not flexible enough for our needs.  We needed to
  584. use SMPTE time units, we needed to control color, style, and positioning of
  585. text, we needed to insert comments in the script and inside the text, and
  586. we needed no restrictions on how time events were sequenced.  (We also
  587. needed something that displayed text faster and more cleanly, but that had
  588. nothing to do with the file format.)
  589.  
  590. The preceding paragraph is not meant to be critical of Mr. Jenks' work.
  591. TurboTitle was a fine program for its time, and it served to provide some
  592. inspirational influence for JACOsub.
  593.  
  594. The JACOsub script file format is the most flexible yet developed.  Scripts
  595. can be as simple as TurboTitle scripts, containing only timing numbers and
  596. text, or you can go all out with global commands and complex formatting
  597. directives.
  598.  
  599. Following the example of TurboTitle's author:  Please, if you're a
  600. programmer, adopt the JACOsub format standard for future titling software
  601. products.  The format is flexible enough to evolve and grow (and it
  602. certainly has done so since the program's inception), so if you have
  603. suggestions for improvements or changes, please let the author know.
  604.  
  605. And especially, if you want JACOsub to support another file format, send
  606. the specifications and the author will try to work it into either the
  607. program itself or the jconvert utility.
  608.  
  609.  
  610. 10.  SHAREWARE REGISTRATION / COMMERCIAL LICENSING
  611. ==================================================
  612.  
  613. Please refer to the file register.doc.
  614.  
  615.  
  616.  
  617. 11.  LEGAL DISCLAIMER
  618. =====================
  619. (Shamelessly adapted from Haventree's EasyFlow documentation)
  620.  
  621. We don't claim JACOsub is good for anything -- if you think it is, great,
  622. but it's up to you to decide.  If JACOsub doesn't work: tough.  If you
  623. lose a million because JACOsub messes up, it's you that's out the million,
  624. not us.  If you don't like this disclaimer: tough.  We reserve the right
  625. to do the absolute minimum provided by law, up to and including nothing!
  626.  
  627. This is basically the same disclaimer that comes with all other software
  628. packages, but Ours is in plain English and Theirs is in Legalese.
  629.  
  630. Additional disclaimer:  The author will attempt to update the software as
  631. needed, but is not obligated to do so (but so far he has a pretty good
  632. record).
  633.  
  634.  
  635.  
  636. 12.  SUPPORT, TECHNICAL QUESTIONS, SUGGESTIONS, BUG REPORTS
  637. ===========================================================
  638.  
  639. You can contact the author, Alex Matulich, by mail at the address in
  640. section 2 of this file.  Alex may be reached via email, using these
  641. addresses:
  642.  
  643.    Internet:  matulich_a@SEAA.NAVSEA.NAVY.MIL
  644.               alex@bilver.oau.org (should automatically forward)
  645.               Alex.Matulich@animece.oau.org (last resort)
  646.  
  647.     Fidonet:  1:363/137, name "Alex Matulich" (last resort)
  648.  
  649.    WWW site:  Unicorn Research Corporation
  650.               http://www.unicorn.us.com/jacosub
  651.  
  652. Support BBS:  Anime Central 407-645-2241, N-8-1, 28,800 maximum baud
  653.               Fidonet address 1:363/137.
  654.               The latest version of JACOsub, plus a fairly massive
  655.               collection of timed scripts contributed by JACOsub users,
  656.               are in the JACOsub Support file area.
  657.  
  658.               Please do not ask questions of the Sysop regarding JACOsub!
  659.               Instead please direct all questions to Alex Matulich.
  660.  
  661. Email server: Anime Central BBS has an email server with which you may
  662.               request the latest version of JACOsub, scripts, and Anime-
  663.               related material to be sent to you through email.  To get
  664.               started, simply send email to ftpmail@animece.oau.org.  In
  665.               the body of your message put this single line:
  666.  
  667.               send allfiles.lzh
  668.  
  669.               This is a complete listing of files on Anime Central.  The
  670.               archive will be sent to you in uuencoded format, so you will
  671.               require a uudecode utility to convert it to usable form.  You
  672.               will also need LZ or LHA to extract the contents of .lzh or
  673.               .lha archives.
  674.  
  675.               IMPORTANT:  PLEASE LIMIT YOUR FTPMAIL REQUESTS TO LESS THAN
  676.               ----------> 500 K PER DAY.  Abusing this service will cause
  677.                           it to disappear forever, for everyone!
  678.  
  679.               JACOsub software and scripts are in the JACOsub file area.
  680.               New versions of JACOsub will always have a file name of the
  681.               form jcosub##.lzh, where ## is the version number; for
  682.               example, version 2.5 would be jcosub25.lzh.
  683.  
  684.         FTP:  The latest version of JACOsub is always available at the
  685.               support BBS above, or at these FTP sites ("??" = version):
  686.               ftp://ftp.unicorn.us.com/pub/jacosub/jcosub??.lzh
  687.  
  688.               JACOsub may also be found on any Aminet site or mirror, e.g.:
  689.               ftp://ftp.wustl.edu/pub/aminet/gfx/show/jcosub??.lha
  690.  
  691.               Registrations are for sale via credit card from Alberts
  692.               Ambry at http://www.alberts.com.
  693.  
  694. IMPORTANT:  WHEN SUBMITTING A BUG REPORT, BE SURE THE PROBLEM IS REPEATABLE
  695. AND SPECIFY THE CONDITIONS UNDER WHICH THE PROBLEM OCCURRED.  Too many
  696. people report problems like "I got an error message when I tried to play my
  697. script" with no other information.  This kind of report helps nobody.  What
  698. version of JACOsub?  What version of AmigaDOS?  What kind of computer?
  699. What were you doing prior to noticing the problem?  Can you reproduce it
  700. and isolate it enough for ME to be able to do the same?
  701.  
  702. If you encounter a problem, try to isolate it.  If the problem is being
  703. caused by something in your script, send the author a small sample script
  704. with your bug report that demonstrates the problem.  Try running the
  705. program on another machine -- if it runs fine on another machine, try to
  706. determine what's different about your setup that's causing the trouble.
  707. And try to describe the bug as completely as possible in your report.
  708.  
  709.  
  710. 13.  KNOWN BUGS -- PLEASE HELP
  711. ==============================
  712.  
  713. From time to time a problem comes up that completely mystifies me.  The
  714. purpose of this section is to list problems reported by users which I
  715. cannot reproduce.  If you find a way to reproduce them reliably, PLEASE
  716. let me know (my addresses are at the end of section 2 of this document).
  717. Please provide as complete a description as possible, as described in the
  718. previous section.
  719.  
  720. 1.  The Color Cycle effect will lock up only on AGA machines when trying
  721.     to cycle an imported graphic while playing a script with either 5 or
  722.     6 video buffers.  It works for all other combinations.
  723.  
  724. 2.  When attempting to play a script, sometimes the following error
  725.     message appears:  "Unable to create temporary ... RastPort for font
  726.     outlines or shadows."  This messge can appear even if the computer has
  727.     sufficient video memory.  The only known solutions are to re-start
  728.     JACOsub, or re-boot, and try again.  I myself have not been able to
  729.     reproduce this bug.  I must have done something in version 2.4 or 2.5
  730.     to fix it, because it has rarely shown up since then.
  731.  
  732. 3.  I have one isolated report of titles flashing up on the screen only
  733.     momentarily, regardless of start and stop times, when trying to play a
  734.     script converted from TurboTitle, under AmigaDOS 1.3 on an Amiga 500,
  735.     when the timer is set to "Event" ("Polled" works fine).
  736.  
  737. 4.  Enforcer hits -- Please inform me of any you encounter.  They should
  738.     be eliminated by now, as far as I know.  Nearly all found so far have
  739.     been harmless errors involving reading from illegal memory addresses
  740.     (like dereferencing a structure pointer set to NULL, for example).
  741.  
  742.  
  743. If you're still reading this far, thank you for using JACOsub.
  744.  
  745. End of Overview.doc.
  746.